/*
 * Copyright (c) 2013 Tob
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package de.tudarmstadt.kom.androidsensorapi.datarepresentation.location;

/**
 * Created by Tobias Welther
 */
public enum LocationProvider {
    /**
     * The GPS SensorInterface of the device
     */
    GPS("GPSProvider"),

    /**
     * The Cell location provided by the connected phone pole
     */
    CELL("CELLProvider"),

    /**
     * Another SensorInterface not specified
     */
    OTHER("Other");


    /**
     * The Android internal Name of the SensorInterface
     */
    private final String name;

    LocationProvider(String name){
        this.name = name;
    }


    /**
     * Returns an intern representation of the provider passed as String
     * When no valid Provider is found, {@link #OTHER} is returned
     *
     * @return LocationProvider associated by String
     */
    public static LocationProvider resolve(String providerName){
        for(LocationProvider provider : values()){
            if(provider.name.equalsIgnoreCase(providerName)){
                return provider;
            }
        }

        return OTHER;
    }
}

